<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <title>OpenLayers v8.2.0 API - Module: ol/source/IIIF</title>
    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <script src="https://code.jquery.com/jquery-3.6.0.min.js" crossorigin="anonymous"></script>
    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0/dist/js/bootstrap.bundle.min.js"
        crossorigin="anonymous"></script>
    <link rel="stylesheet" type="text/css"
        href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0/dist/css/bootstrap.min.css" crossorigin="anonymous">
    <link rel="stylesheet" type="text/css"
        href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.1.2/css/fontawesome.min.css"
        crossorigin="anonymous">
    <link rel="stylesheet" type="text/css"
        href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.1.2/css/solid.css" crossorigin="anonymous">
    <link rel="stylesheet" type="text/css"
        href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.1.2/css/brands.css" crossorigin="anonymous">
    <link rel="stylesheet" type="text/css" href="styles/prettify-tomorrow.css">
    <link rel="stylesheet" type="text/css" href="styles/jaguar.css">
    <link rel="stylesheet" type="text/css" href="styles/carbon.css">
    <link rel="stylesheet" type="text/css" href="/theme/ol.css">
    <link rel="stylesheet" type="text/css" href="/theme/site.css">
</head>

<body>
    <header class="navbar navbar-expand-sm navbar-dark mb-3 px-3 py-0 fixed-top" role="navigation">
        <a class="navbar-brand" href="/"><img src="/theme/img/logo-dark.svg" width="70" height="70"
                alt="">&nbsp;OpenLayers</a>
        <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#olmenu"
            aria-controls="olmenu" aria-expanded="false" aria-label="Toggle navigation">
            <span class="navbar-toggler-icon"></span>
        </button>

        <!-- menu items that get hidden below 768px width -->
        <nav class="collapse navbar-collapse" id="olmenu">
            <ul class="nav navbar-nav ms-auto">
                <li class="nav-item dropdown">
                    <a class="nav-link dropdown-toggle" href="#" id="docdropdown" role="button"
                        data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Docs</a>
                    <div class="dropdown-menu dropdown-menu-end mb-3" aria-labelledby="docdropdown">
                        <a class="dropdown-item" href="/doc/">Docs</a>
                        <div class="dropdown-divider"></div>
                        <a class="dropdown-item" href="/doc/quickstart.html"><i
                                class="fa fa-check fa-fw me-2 fa-lg"></i>快速入门</a>
                        <a class="dropdown-item" href="/doc/faq.html"><i
                                class="fa fa-question fa-fw me-2 fa-lg"></i>FAQ</a>
                        <a class="dropdown-item" href="/doc/tutorials/"><i
                                class="fa fa-book fa-fw me-2 fa-lg"></i>Tutorials</a>
                        <div class="dropdown-divider"></div>
                        <a class="dropdown-item" href="https://stackoverflow.com/questions/tagged/openlayers"><i
                                class="fab fa-stack-overflow fa-fw me-2"></i>Ask a Question</a>
                    </div>
                </li>
                <li class="nav-item"><a class="nav-link" href="/en/latest/examples/">Examples</a></li>
                <li class="nav-item dropdown">
                    <a class="nav-link dropdown-toggle" href="#" id="apidropdown" role="button"
                        data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
                        <i class="fa fa-sitemap me-1"></i>API
                    </a>
                    <div class="dropdown-menu dropdown-menu-end mb-3" aria-labelledby="apidropdown">
                        <a class="dropdown-item" href="/en/latest/apidoc/"><i
                                class="fa fa-sitemap fa-fw me-2 fa-lg"></i>v8.2.0
                            (latest)</a </div>
                </li>
            </ul>
        </nav>
    </header>

    <div class="container-fluid">
        <div id="wrap" class="row">
            <div class="navigation col-md-4 col-lg-3">
                <div class="search-wrapper">
                    <div class="search">
                        <input id="search" type="text" autocomplete="off" class="form-control input-sm"
                            placeholder="Search Documentation">
                    </div>
                </div>
                <div class="navigation-list-wrapper">
                    <ul class="navigation-list search-empty">
                        <li class="loading">Loading …
                    </ul>
                </div>
            </div>

            <div class="main col-md-8 col-lg-9">
                <h1 class="page-title" data-filename="module-ol_source_IIIF.html">Module: ol/source/IIIF</h1>
                <div id="latest-check" class="alert alert-warning alert-dismissible" role="alert" style="display:none">
                    <button id="latest-dismiss" type="button" class="btn-close" data-bs-dismiss="alert"
                        aria-label="Close"></button>
                    This documentation is for OpenLayers v<span id="package-version">8.2.0</span>. The <a
                        id="latest-link" href="#" class="alert-link">latest</a> is v<span id="latest-version"></span>.
                </div>




                <section class="content">

                    <header>
                        <h2 class="my-3">ol/source/IIIF
                        </h2>
                        <br>




                        <div class="row p-3 ">
                            <!-- <div id="ad" class="col-lg-5 order-2 align-self-center border rounded bg-light ">
                                <script async type="text/javascript"
                                    src="https://cdn.carbonads.com/carbon.js?serve=CE7DV53U&placement=openlayersorg"
                                    id="_carbonads_js"></script>
                            </div> -->

                        </div>
                    </header>

                    <article>
                        <div class="container-overview">






                            <dl class="details">





















                            </dl>




                        </div>










                        <h3 class="subsection-title">Classes</h3>

                        <dl>
                            <dt><a href="module-ol_source_IIIF-IIIF.html">IIIF</a></dt>
                            <dd></dd>
                        </dl>











                        <h3 class="subsection-title">Type Definitions</h3>

                        <dl>

                            <dt class="">
                                <div class="nameContainer">
                                    <div class="anchor" id="~Options">
                                    </div>
                                    <h4 class="name">
                                        Options<span class="type-signature type object">{Object}</span>


                                    </h4>
                                </div>

                            </dt>
                            <dd class="">



                                <dl class="details">


                                    <h5 class="subsection-title">Properties:</h5>

                                    <dl>

                                        <table class="props">
                                            <thead>
                                                <tr>

                                                    <th>Name</th>


                                                    <th>Type</th>

                                                    <th class="last">Description</th>
                                                </tr>
                                            </thead>

                                            <tbody>


                                                <tr>

                                                    <td class="name"><code>attributions</code></td>


                                                    <td class="type">


                                                        <span class="param-type"><a
                                                                href="module-ol_source_Source.html#~AttributionLike">AttributionLike</a></span>

                                                        | undefined


                                                    </td>

                                                    <td class="description last">
                                                        <p>Attributions.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>attributionsCollapsible</code></td>


                                                    <td class="type">


                                                        <span class="param-type">boolean</span>



                                                        <br>(defaults to true)


                                                    </td>

                                                    <td class="description last">
                                                        <p>归属信息是否可覆盖</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>cacheSize</code></td>


                                                    <td class="type">


                                                        <span class="param-type">number</span>

                                                        | undefined


                                                    </td>

                                                    <td class="description last">
                                                        <p>Size of the cache.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>crossOrigin</code></td>


                                                    <td class="type">


                                                        <span class="param-type">null</span>
                                                        |

                                                        <span class="param-type">string</span>

                                                        | undefined


                                                    </td>

                                                    <td class="description last">
                                                        <p>The value for the crossOrigin option of the request.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>extent</code></td>


                                                    <td class="type">


                                                        <span class="param-type"><a
                                                                href="module-ol_extent.html#~Extent">Extent</a></span>



                                                        <br>(defaults to [0, -height, width, 0])


                                                    </td>

                                                    <td class="description last">
                                                        <p>The extent.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>format</code></td>


                                                    <td class="type">


                                                        <span class="param-type">string</span>



                                                        <br>(defaults to 'jpg')


                                                    </td>

                                                    <td class="description last">
                                                        <p>Requested image format.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>interpolate</code></td>


                                                    <td class="type">


                                                        <span class="param-type">boolean</span>



                                                        <br>(defaults to true)


                                                    </td>

                                                    <td class="description last">
                                                        <p>Use interpolated values when resampling. By default,
                                                            linear interpolation is used when resampling. Set to false
                                                            to use the nearest neighbor instead.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>projection</code></td>


                                                    <td class="type">


                                                        <span class="param-type"><a
                                                                href="module-ol_proj.html#~ProjectionLike">ProjectionLike</a></span>

                                                        | undefined


                                                    </td>

                                                    <td class="description last">
                                                        <p>Projection.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>quality</code></td>


                                                    <td class="type">


                                                        <span class="param-type">string</span>

                                                        | undefined


                                                    </td>

                                                    <td class="description last">
                                                        <p>Requested IIIF image quality. Default is 'native'
                                                            for version 1, 'default' for versions 2 and 3.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>reprojectionErrorThreshold</code></td>


                                                    <td class="type">


                                                        <span class="param-type">number</span>



                                                        <br>(defaults to 0.5)


                                                    </td>

                                                    <td class="description last">
                                                        <p>Maximum allowed reprojection error (in pixels).
                                                            Higher values can increase reprojection performance, but
                                                            decrease precision.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>resolutions</code></td>


                                                    <td class="type">


                                                        <span class="param-type">Array.&lt;number></span>

                                                        | undefined


                                                    </td>

                                                    <td class="description last">
                                                        <p>Supported resolutions as given in IIIF 'scaleFactors'</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>size</code></td>


                                                    <td class="type">


                                                        <span class="param-type"><a
                                                                href="module-ol_size.html#~Size">Size</a></span>




                                                    </td>

                                                    <td class="description last">
                                                        <p>Size of the image [width, height].</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>sizes</code></td>


                                                    <td class="type">


                                                        <span class="param-type">Array&lt;<a
                                                                href="module-ol_size.html#~Size">Size</a>></span>

                                                        | undefined


                                                    </td>

                                                    <td class="description last">
                                                        <p>Supported scaled image sizes.
                                                            Content of the IIIF info.json 'sizes' property, but as array
                                                            of Size objects.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>state</code></td>


                                                    <td class="type">


                                                        <span class="param-type"><a
                                                                href="module-ol_source_Source.html#~State">State</a></span>

                                                        | undefined


                                                    </td>

                                                    <td class="description last">
                                                        <p>源状态。</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>supports</code></td>


                                                    <td class="type">


                                                        <span class="param-type">Array.&lt;string></span>



                                                        <br>(defaults to [])


                                                    </td>

                                                    <td class="description last">
                                                        <p>Supported IIIF region and size calculation
                                                            features.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>tilePixelRatio</code></td>


                                                    <td class="type">


                                                        <span class="param-type">number</span>

                                                        | undefined


                                                    </td>

                                                    <td class="description last">
                                                        <p>Tile pixel ratio.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>tileSize</code></td>


                                                    <td class="type">


                                                        <span class="param-type">number</span>
                                                        |

                                                        <span class="param-type"><a
                                                                href="module-ol_size.html#~Size">Size</a></span>

                                                        | undefined


                                                    </td>

                                                    <td class="description last">
                                                        <p>Tile size.
                                                            Same tile size is used for all zoom levels. If tile size is
                                                            a number,
                                                            a square tile is assumed. If the IIIF image service supports
                                                            arbitrary
                                                            tiling (sizeByH, sizeByW, sizeByWh or sizeByPct as well as
                                                            regionByPx or regionByPct
                                                            are supported), the default tilesize is 256.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>transition</code></td>


                                                    <td class="type">


                                                        <span class="param-type">number</span>

                                                        | undefined


                                                    </td>

                                                    <td class="description last">
                                                        <p>Transition.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>url</code></td>


                                                    <td class="type">


                                                        <span class="param-type">string</span>

                                                        | undefined


                                                    </td>

                                                    <td class="description last">
                                                        <p>Base URL of the IIIF Image service.
                                                            This should be the same as the IIIF Image ID.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>version</code></td>


                                                    <td class="type">


                                                        <span class="param-type">Versions</span>



                                                        <br>(defaults to Versions.VERSION2)


                                                    </td>

                                                    <td class="description last">
                                                        <p>Service's IIIF Image API version.</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>zDirection</code></td>


                                                    <td class="type">


                                                        <span class="param-type">number</span>
                                                        |

                                                        <span class="param-type"><a
                                                                href="module-ol_array.html#~NearestDirectionFunction">NearestDirectionFunction</a></span>



                                                        <br>(defaults to 0)


                                                    </td>

                                                    <td class="description last">
                                                        <p>Choose whether to use tiles with a higher or lower zoom level
                                                            when between integer
                                                            zoom levels. See <a
                                                                href="module-ol_tilegrid_TileGrid-TileGrid.html#getZForResolution"><code>getZForResolution</code></a>.
                                                        </p>

                                                    </td>
                                                </tr>


                                            </tbody>
                                        </table>
                                    </dl>






















                                </dl>



                            </dd>

                        </dl>



                    </article>

                </section>




            </div>
        </div>
    </div>
    <script>prettyPrint();</script>
    <script src="scripts/linenumber.js"></script>
    <script src="scripts/main.js"></script>
</body>

</html>